home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / scram_38.zip / SCRAMBLE.DOC < prev    next >
Text File  |  1993-05-15  |  15KB  |  393 lines
  1.  
  2.  
  3.                        ============================
  4.                              S C R A M B L E !
  5.                        ============================
  6.  
  7.                       COPYRIGHT 1990,93 T&J SOFTWARE
  8.  
  9.         One of the T&J Software Collection of multi-BBS door programs.
  10.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  11.              UltraBBS, Telegard, TriBBS, Remote Access, WWIV, and
  12.  
  13.                        VERSION 3.8      5/15/93
  14.  
  15.                                    By
  16.  
  17.                                Tom Wildoner
  18.                              397 West Broadway
  19.                               Jim Thorpe, PA
  20.                                   18229
  21.                             VOICE (717)325-9480
  22.  
  23.                                    From
  24.  
  25.                                The T&J BBS
  26.                               (717)325-9481
  27.                              12/24/9600/14400
  28.  
  29. LEGALITIES:
  30. ===========
  31.  
  32.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  33.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  34.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  35.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  36.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  37.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  38.       OR BREACH OF ANY WARRANTY.
  39.  
  40. SUPPORT:
  41. ========
  42.  
  43. Please feel free to call me at my BBS number or voice number. Word
  44. lists will be available on my BBS for download as they are prepared.
  45.  
  46. DISTRIBUTION:
  47. =============
  48.  
  49. You may make this file available for downloading from your BBS or you may
  50. upload it to any BBS of your choice, provided that you do not make any
  51. changes to the contents of the archive (ZIP file). The archive and its
  52. individual contents may not be used by any service that charges any money
  53. whatsoever, without the written permission of the author.
  54.  
  55. REGISTERING:
  56. ============
  57.  
  58. Scramble will only use the first 25 words from the list of over
  59. 30,000 words until registered.
  60.  
  61. Once registered -- it will unlock all the features of the registered
  62. version including the full 30,000+ word lists!
  63.  
  64. FEATURES:
  65. =========
  66.            --- Return to BBS on dropped carrier.
  67.            --- 4-minutes no activity will return to BBS.
  68.            --- Online Chat.
  69.            --- You can blank the display.
  70.            --- Dump user back to BBS.
  71.            --- Drop to DOS function.
  72.            --- Desqview Aware.
  73.            --- COM0-15 support and non-standard IRQ's.
  74.            --- Colorful ANSI screens.
  75.            --- Makes TOP TEN ANSI & ASCII bulletins.
  76.            --- NO BRUN module needed for play.
  77.            --- BETA tested on five different boards.
  78.            --- Use of HOT KEYS while in the door.
  79.            --- Support BBS available.
  80.            --- Easily RESET the entire program.
  81.            --- Self maintaining no maintenance required.
  82.            --- Door resets every month to give ALL players a chance.
  83.            --- Fossil driver support.
  84.  
  85.  
  86. INSTALLATION:     IMPORTANT!!!!!!!
  87. ==================================
  88.  
  89. Run Scramble using the command line UTILITY.
  90.  
  91. Example: SCRAM UTILITY
  92.  
  93. Then, reset the door from scratch. You can also easily setup your
  94. configuration files this way!
  95.  
  96.  
  97. UPGRADING:
  98. ==========
  99.  
  100. If you are running a version prior to v3.8 of the door, you'll have to
  101. reinstall the entire door from scratch (including the SYSOP.CFG). Too
  102. many changes were made for an "easy" upgrade.
  103.  
  104.  
  105. CONFIGURATION:
  106. =============
  107.  
  108. Example configuration file for PCBOARD.SYS
  109. ------------------------------------------
  110.  
  111. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  112. T&J Software        <=-  (Change this to your BBS name)
  113. Tom                 <=-  (The Sysop's first name)
  114. Wildoner            <=-  (The Sysop's last name)
  115.  
  116. Example configuration file for USERS.SYS
  117. ----------------------------------------
  118.  
  119. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  120. T&J Software        <=-  (Change this to your BBS name)
  121. Tom                 <=-  (The Sysop's first name)
  122. Wildoner            <=-  (The Sysop's last name)
  123.  
  124. Example configuration file for DOOR.SYS
  125. ---------------------------------------
  126.  
  127. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  128. T&J Software        <=-  (Change this to your BBS name)
  129. Tom                 <=-  (The Sysop's first name)
  130. Wildoner            <=-  (The Sysop's last name)
  131.  
  132. Example configuration file for USERINFO.DAT
  133. -------------------------------------------
  134.  
  135. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  136. T&J Software        <=-  (Change this to your BBS name)
  137. Tom                 <=-  (The Sysop's first name)
  138. Wildoner            <=-  (The Sysop's last name)
  139. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  140.  
  141. Example configuration file for CALLINFO.BBS
  142. -------------------------------------------
  143.  
  144. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  145. T&J Software        <=-  (Change this to your BBS name)
  146. Tom                 <=-  (The Sysop's first name)
  147. Wildoner            <=-  (The Sysop's last name)
  148.  
  149. Example configuration file for DORINFOx.DEF
  150. -------------------------------------------
  151.  
  152. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  153.                           where 'x' is the BBS Node number.
  154. T&J Software        <=-  (Change this to your BBS name)
  155. Tom                 <=-  (The Sysop's first name)
  156. Wildoner            <=-  (The Sysop's last name)
  157.  
  158. Example configuration file for SFDOORS.DAT
  159. ------------------------------------------
  160.  
  161. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  162. T&J Software        <=-  (Change this to your BBS name)
  163. Tom                 <=-  (The Sysop's first name)
  164. Wildoner            <=-  (The Sysop's last name)
  165.  
  166. Example configuration file for CHAIN.TXT
  167. ----------------------------------------
  168.  
  169. C:\BBS\CHAIN.TXT    <=-  (Full pathname of your CHAIN.TXT file)
  170. T&J Software        <=-  (Change this to your BBS name)
  171. Tom                 <=-  (The Sysop's first name)
  172. Wildoner            <=-  (The Sysop's last name)
  173.  
  174. Example configuration file for GTUSER.BBS
  175. -----------------------------------------
  176.  
  177. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  178. T&J Software        <=-  (Change this to your BBS name)
  179. Tom                 <=-  (The Sysop's first name)
  180. Wildoner            <=-  (The Sysop's last name)
  181. 1                   <=-  (COM port number - defaults to 1)
  182. 1                   <=-  (Node number - defaults to 1)
  183.  
  184. Example Batch File
  185. ==================
  186.  
  187. A sample batch file is included and is similer to the following:
  188.    ECHO OFF
  189.    CD\DOORS\SCRAM           <=- Switch to the door's Directory.
  190.    SCRAM SCRAM.CFG          <=- Execute the door program and pass the
  191.                                 configuration filename to the program.
  192.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  193.    BOARD                    <=- Restart BBS.
  194.  
  195. This Door is multi-node  compatible so you may run more than 1 node from
  196. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  197. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  198. variables, (q.v.)
  199.  
  200. Environment Variables
  201. =====================
  202.  
  203. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  204. variables. Non-PCBoard systems may also use these variables by including
  205. the following in either your BBS batch or AUTOEXEC.BAT
  206.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  207.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  208. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  209. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  210. .CFG file for multi-node operation!
  211.  
  212. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  213. command line.  For example:
  214.  
  215.      SCRAM SCRAM.CFG /5
  216. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  217.      SCRAM SCRAM.CFG /%IRQ%
  218.  
  219. This tells the program to use IRQ 5 instead of the standard IRQ.
  220.  
  221.   Had reports of conflicts when using non-standard IRQ's on Novell/Netware
  222.  systems. Seems Novell also uses the / character so something went screwy
  223.  somewhere. So I added the * (asterisk) which may be used instead of the /
  224.  in case of a conflict. In other words, /%IRQ% and *%IRQ% will both work
  225.  and are interchangeable.
  226.  
  227. When specifying the location of the system file on line 1 of the doors .CFG
  228. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  229. and %wcnodeid%. Some examples:
  230.  PCBoard: 
  231.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  232.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  233.  
  234.  Wildcat!:
  235.    USERINFO.DAT in C:\WC\NODE1   - C:\WC\NODE%wcnodeid%
  236.  
  237. Non-PCBoard systems may use the PCB environment variables by setting them
  238. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  239.  SET PCBDRIVE=C:
  240.  SET PCBDIR=\BBSDIR
  241.  SET PCBNODE=1
  242.  
  243. Fossil Driver Support
  244. ---------------------
  245. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  246. Fossil driver instead of the standard COM ports, just put /FD on the command
  247. line when running the door. For example:
  248.      MYDOOR MYDOOR.CFG /FD
  249. indicates that a Fossil driver is present and should be used. If no Fossil
  250. driver is detected, DoorFrame will print a message to that effect and exit
  251. the door gracefully.
  252.  
  253.  
  254. Sysop Keys
  255. ==========
  256.  
  257. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  258.          written to DOOR.SYS and USERS.SYS
  259. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  260.          and/or written to DOOR.SYS and USERS.SYS
  261. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  262. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  263.          and/or written to DOOR.SYS and USERS.SYS
  264. F8    -  Returns the caller involuntarily to the BBS.
  265. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  266.          and/or written to DOOR.SYS and USERS.SYS
  267. F10   -  Activates SysOp CHAT mode within the DOOR.
  268. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  269. UP    -  Give the caller extra time while in the DOOR.  
  270. DN    -  Subtract time from the caller while in the DOOR. 
  271. HOME  -  HELP key for Status Line options.
  272. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  273. ALT-X -  PCBoard will exit after current caller logs off. Value is
  274.          passed to PCBoard. Not available on non-PCBoard systems.
  275.  
  276.  
  277. YOUR CONFIGURATION FILE:
  278. ========================
  279.  
  280. Change the SYSOP.CFG file to meet your needs:
  281.  
  282. 20
  283. 5
  284. N
  285. C:\BULL.BBS
  286. C:\BULL.BBS
  287. Y
  288. 4
  289.  
  290. LINE 1: Number of words/play a user may attempt.
  291. LINE 2: Current month. Used for resetting the scores monthly!
  292. LINE 3: Tournament mode (Y or N)
  293. LINE 4: Path to your color bulletin.
  294. LINE 5: Path to your ASCII bulletin.
  295. LINE 6: Do you want bulletins created? Y or N
  296. LINE 7: How many times a player may enter the door per day.
  297.  
  298.  
  299. TOURNAMENT MODE:
  300. ================
  301.  
  302. Turning tournament mode on does the following: The first player of the
  303. day will have to wait a few seconds until the tournament words are
  304. selected. Next, the tournament words will be compiled into a file
  305. called TOURNY.TXT. All users who play today will get the same words
  306. (scrambled differently).
  307.  
  308. LOCAL MODE:
  309. ===========
  310.  
  311. To run in LOCAL mode simply run SCRAMBLE using the LOCAL command line:
  312.  
  313. Example: SCRAM LOCAL
  314.  
  315. RESETTING:
  316. ==========
  317.  
  318. Scramble will reset at the first of each month -- no maintenance
  319. needed. However, you can reset Scramble any time you wish using the
  320. UTILITY command string and then selecting the appropriate menu
  321. item.
  322.  
  323. WORD LISTS:
  324. ===========
  325.  
  326. Word lists are now history, we've compiled the words into one large
  327. database of words. This has dramatically increased the speed of the
  328. door!
  329.  
  330. FUTURE VERSIONS:
  331. ================
  332.  
  333.    ---> What would you like to see added? Just let me know.
  334.  
  335. VERSION HISTORY:
  336. ================
  337.  
  338. Version 1.00 ......... First release. 2/2/91
  339. Version 1.10 ......... Maintenance update. Changed BBS name. 8/17/91
  340. Version 2.00 ......... Now using BASIC PDS v7.1, all external files
  341.                        placed inside the main code, now support WC!
  342.                        2.x and 3.x, added tournament mode. 10/1/91
  343. Version 2.10 ......... Fix for BBS running with com port unlocked.
  344.                        Other small mods made also.  02/01/92
  345. Version 3.00 ......... Converted to DoorFrame routines -- facelift
  346.                        for the program. 02/23/92
  347. Version 3.10 ......... Recompiled using newer DoorFrame routines and
  348.                        added new bulletin routines.  04-17-1992
  349. Version 3.50 ......... Cleaned the code a little, added the ability
  350.                        to view the TOP TEN while in the door, got
  351.                        rid of the SEXTRA program, made a new RESET
  352.                        program, moved tournament routines inside the
  353.                        main code. 05-16-92
  354. Version 3.60 ......... Verify and Setup have been moved into the main
  355.                        code. Door updated with the newest door routines.
  356.                        05-24-92
  357. Version 3.60 ......... Fixed small problem with Scramble not resetting
  358.                        the scores monthly. 06-06-92
  359. Version 3.70 ......... Basically re-wrote the entire door. Got rid of
  360.                        some menacing screens. Added 'V' at the main
  361.                        menu to view the scores. Added almost 30,000
  362.                        words to the door. Now supports fossil drivers
  363.                        and IRQ number larger than one
  364.                        digit. Got rid of the BONUS CATAGORY listing
  365.                        and decided to give bonus points just on word
  366.                        length. Added a new timer function that will
  367.                        give 20 seconds plus however many letters there
  368.                        are in the word. Added better support for
  369.                        boards running in a network environment and
  370.                        also now supports the short version of
  371.                        DOOR.SYS. The screen now automatically redraws
  372.                        after a CHAT or DROP to DOS. Got rid of the
  373.                        VERIFY program to verify word lists. The door
  374.                        will now run "registered" when playing locally
  375.                        and allow multiple people to play locally
  376.                        instead of just the sysop. 12-04-1992
  377. Version 3.80 ......... Got rid of all the seperate word lists and
  378.                        compiled to words into one large database,
  379.                        added support for COM0-15, added support for
  380.                        more than one play per day, bulletins are
  381.                        now optional, speeded up the code a little.
  382.                        05-15-1993
  383.  
  384. That's all there is to it! If you have any problems or questions
  385. please feel free to call the T&J BBS at (717)325-9481.
  386.  
  387. Future add on word lists will be available to DL from my BBS.
  388.  
  389. See the REGISTER.TXT file for registering.
  390.  
  391. Your users will get a lot of duplicate words until the game is
  392. registered.
  393.